home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / ffgra103.zip / FFG.DOC < prev    next >
Text File  |  1992-03-28  |  12KB  |  246 lines
  1.  
  2.    ┌──────────────────────┬───────────────────────────────────────┬────────┐
  3.    │ Fast File Gen 1.03ra │ A quick 'ALL FILES' generator for RA. │ M ▀▀▄  │
  4.    │  Copyright (C) 1992  ├───────────────────────────────────────┤   ▄▄ █ │
  5.    │          by          │ Maelstrom Online Services ■ 1:117/351 │  ████  │
  6.    │      Kit Cragin      ├───────────────────────────────────────┤ █ ▀▀   │
  7.    │  Maelstrom Software  │ 409-696-8722 HST/DS ■ 693-3753 2400bd │  ▀▄▄ S │
  8.    └──────────────────────┴───────────────────────────────────────┴────────┘
  9.  
  10.    DESCRIPTION
  11.    ─────────────────────────────────────────────────────────────────────────
  12.    Fast File Gen (FFG)  is a simple, but quick and powerful `ALL FILES' list
  13.    generator for Remote Access BBSes  (v1.10 up).  Don't let the short docu-
  14.    mentation fool you:  FFG has many useful features, and for $9 to register
  15.    it's an invaluable tool for the RA SysOp.
  16.  
  17.    FEATURES
  18.    ─────────────────────────────────────────────────────────────────────────
  19.    I created a variety of SysOp configurable features so the program will be
  20.    easy and flexible for you to use.
  21.  
  22.    ■ Generates lists of all file areas or just the ones you specify
  23.    ■ Handles read-only media, and creates index files of  file sizes so that
  24.        subsequent file listings do not need to access the CD-ROM at all
  25.    ■ MultiNode Aware (can be run while all users are online)
  26.    ■ Output is fully configurable with a number of replaceable codes
  27.    ■ Multiline descriptions are supported
  28.    ■ List format is: <filename> <size> <desciption> [<optional line>]
  29.    ■ Handles comments that have been imbedded into FILES.BBS listings
  30.  
  31.    Release 1.1  will have many, many more features.  Some you may have seen;
  32.    some  will  be surprisingly useful.  But register  now for $9, and get in
  33.    cheap!
  34.  
  35.    LIABILITY
  36.    ─────────────────────────────────────────────────────────────────────────
  37.    The author of this software,  Kit Cragin, assumes no liability whatsoever
  38.    for any damage or  loss of data done to any computer system which results
  39.    from the use of FFG -- Not that anything is likely to happen!
  40.  
  41.    RESTRICTIONS/REGISTRATION
  42.    ─────────────────────────────────────────────────────────────────────────
  43.    Feel free to pass this software on to others,  but make sure there are no
  44.    modifications of any kind. This software is shareware which means you can
  45.    use it for 30 days before you either register it, or discontinue use.
  46.  
  47.    To register, print REGISTER.ME and send a paltry $9 -- I can take my wife
  48.    wife out to dinner and make her happy :).
  49.  
  50.    CONFIGURATION
  51.    ─────────────────────────────────────────────────────────────────────────
  52.    I've designed FFG to be as simple and easy to set up as possible, because
  53.    I know many sysops hate to waste time writing batch files and testing new
  54.    programs. If you follow the steps below, FFG should run without a hitch.
  55.  
  56.    Configuration involves editing the included FFG.CFG file.  This file con-
  57.    tains several types of lines. Those that begin with a
  58.  
  59.       `;'  are comments and do not affect program operation.
  60.       `$'  are configuration parameters.
  61.       `!'  signal the end of a header or footer.
  62.  
  63.    Other lines are considered to be part of a header or footer.
  64.  
  65.    ┌─┐ Edit the configuration parameters.  Note that all parameters follow a
  66.    │1│ `$' in column 1, then a <space> then the parameter (0-38 characters).
  67.    └─┘
  68.          1   Path and filename of the output filelist (eg. ALLFILES.LST)
  69.  
  70.          2   Path to your CONFIG.RA file (Trailing \ is optional)
  71.  
  72.          3   Path to your FILES.RA  file (Trailing \ is optional)
  73.  
  74.          4   Template format of FileNames.  This is a combination of 8 upper
  75.              or lower case `X's, then a `.' or <space>, then 3 `X's.  Upper-
  76.              case X means the FileName's character will uppercase:
  77.  
  78.                         ┌──────────────┬────────────────┐
  79.                         │   TEMPLATE   │ EXAMPLE OUTPUT │
  80.                         ├──────────────┼────────────────┤
  81.                         │ XXXXXXXX.XXX │  FASTFILE.GEN  │
  82.                         │ Xxxxxxxx Xxx │  Fastfile Gen  │
  83.                         │ XxXxxxxx XXX │  FaStfile GEN  │
  84.                         └──────────────┴────────────────┘
  85.  
  86.          5   Format of the FileSize portion of the output.  This can be 1 of
  87.              these 4 types:
  88.                           ┌──────────┬────────────────┐
  89.                           │ TEMPLATE │ EXAMPLE OUTPUT │
  90.                           ├──────────┼────────────────┤
  91.                           │    k,    │ 2,331k         │
  92.                           │    b,    │ 2,312,456,889  │
  93.                           │    k     │ 2331k          │
  94.                           │    b     │ 2312456889     │
  95.                           └──────────┴────────────────┘
  96.  
  97.          6   The number of spaces between FileName and FileSize
  98.  
  99.          7   The number of spaces between FileSize and Description
  100.  
  101.          8   The number of spaces before FileName (usually 0)
  102.  
  103.          9   The number of spaces to indent multiline descriptions
  104.                                              ┌─┐
  105.         10   List of replaceable codes  (see │3│) with which to append  text
  106.              specified in #11 below.         └─┘
  107.  
  108.         11   The text that you want to append to certain  replaceable codes;
  109.              this is used to enhance the output.  For example in the FFG.CFG
  110.              file that came with this archive,  you'll see a `&&a' parameter
  111.              in the  area header and footer.  The next set of characters are
  112.              solidspace `▒'s. The &&a prints out the area name. So we get
  113.  
  114.                            ▒▒▒ New Uploads▒▒▒▒etc.
  115.  
  116.              Since the name `runs into'  the solid spaces,  I want to have a
  117.              <space> appended to the &&a. This will give me
  118.  
  119.                            ▒▒▒ New Uploads ▒▒▒etc.
  120.  
  121.              which looks a little nicer.  If you want 2 spaces, just specify
  122.              that. Simply put the text between `"'s (rabbit ears) eg: "  ".
  123.  
  124.         12   The list of areas that you want to add to your list.  If you're
  125.              doing all your file areas then put `ALL' on the line. If you're
  126.              doing a subset, separate the areas by spaces,  and sequences of
  127.              areas by a `-'. For example
  128.                                          1 4 7-10 12-15 18
  129.  
  130.         13   Do you want  imbedded comments to be generated with your list?
  131.              Enter  YES or NO here.  Comments  are lines  that begin with a
  132.              <space> inside of FILES.BBS's or FILES.nnn's.
  133.  
  134.         14   Scan mode.  Enter NOCHECK, OFFLINE or NOPUT.
  135.  
  136.              NOCHECK - Fastest scan.  If the filename is  in FILES.BBS then
  137.                        it appears on the list.   If the file is not on disk
  138.                        a size of 0k is indicated. (But if your list matches
  139.                        your directory exactly, I'd use this method.)
  140.  
  141.              OFFLINE - Checks to see if the file is on disk.  If it is not,
  142.                        then '[OFFLINE]' is placed in the  filesize  part of
  143.                        the output line. Slower than NOCHECK.
  144.  
  145.              NOPUT   - Checks to see if the file is on disk.  If it is not,
  146.                        then the  filename and description  are not put into
  147.                        the ouput listing at all.  Slower than NOCHECK.
  148.  
  149.    ┌─┐ Edit each of the 4 header/footer areas  to your taste.  Refer to sec-
  150.    │2│ tion -3- for any  replaceable codes  that you might want to use.  The
  151.    └─┘ first header is the `title' or main header to the file list.  The 2nd
  152.        is the header added to the beginning of each file area.  The third is
  153.        the footer added to the bottom  of each file area.  The fourth is the
  154.        'summary' page appended to the end of the list.
  155.  
  156.        All header/footers have a maximum of 50 lines.  The only exception is
  157.        the footer page when being expanded by a `&&A' code.
  158.  
  159.    ┌─┐ Add the Replaceable Codes  in the header/footer areas (see -2- above)
  160.    │3│ as needed. The codes are replaced in `overtype' mode.  So if you have
  161.    └─┘ &&D (date) in a section of text below with a `D' in Section -1-, #11:
  162.  
  163.                 │ =-= &&D -=-=-=-= │
  164.         you get
  165.                 │ =-= 03/07/92 =-= │
  166.  
  167.        The parameters are
  168.  
  169.        &&D - The current date in mm/dd/yy format
  170.        &&T - The current time in hh:mm:ss [am|pm] format
  171.  
  172.        &&a - The current file area's name   as specified in FILES.RA
  173.        &&n - The current file area's number as specified in FILES.RA
  174.        &&f - The number of files found in the area
  175.        &&s - The total size of files in the area (formatted as per Sec.1,#5)
  176.  
  177.        &&N - The total number of file areas processed
  178.        &&F - The total number of all the files in all areas
  179.        &&S - The total size   of all the files in all areas
  180.  
  181.        &&A - A special paramter which outputs 1 line for each file area. The
  182.              line contains the &&a &&f &&s sequences nicely formatted.  This
  183.              makes a nice summary for all your areas.
  184.  
  185.    RUNNING FFG
  186.    ─────────────────────────────────────────────────────────────────────────
  187.    Running FFG is simple.  Just switch to the FFG directory and type FFG, or
  188.    type the \full path\FFG on the commandline.  The FFG.CFG config file will
  189.    be loaded by default.  If you wish to use a different one, add that para-
  190.    meter to the commandline.  Here's a sample section of a nightly maintain-
  191.    ance batch file that generates 3 lists:
  192.  
  193.        REM #1 Generate list of ALL files on BBS
  194.        c:\ra\util\ffg\ffg
  195.        REM #2 Generate list of all adult files
  196.        c:\ra\util\ffg\ffg adult.cfg
  197.        REM #3 Generate list of #1-#2
  198.        c:\ra\util\ffg\ffg regular.cfg
  199.  
  200.    Note that each of the .CFGs contain the appropriate file areas to  gener-
  201.    ate and the appropriate  names of the output lists.  The .CFGs must be in
  202.    the same directory as FFG.EXE.
  203.  
  204.    If an area seems to come up with a list of 0b files, or invalid filesizes
  205.    then type FFG /FIX.  This will delete all invalid FILESIZE.nnn files that
  206.    FFG comes across.  You may then run FFG as normal (new FILESIZE's will be
  207.    created on the next run).
  208.  
  209.    REGISTERING FFG
  210.    ─────────────────────────────────────────────────────────────────────────
  211.    Registration is simple (not to mention appreciated).  There are 2 ways to
  212.    do it; you can choose the one that is easiest for you.
  213.  
  214.    ┌─┐ Call Maelstrom Online Services at 1:117/351
  215.    │1│ 409-696-8722, 764-6516, 693-3753 or 693-3617  & use the online regis-
  216.    └─┘ tration feature  (uses Visa/MasterCard/Discover).  You will receive a
  217.        key immediately!  This is the fastest method.
  218.  
  219.    ┌─┐ Print REGISTER.ME, fill it out & send check/cash/money order  or your
  220.    │2│ visa/mastercard/discover information.  If you're in the FidoNet node-
  221.    └─┘ list, I'll send your key netmail.  Otherwise, US Mail.
  222.  
  223.    NOTES
  224.    ─────────────────────────────────────────────────────────────────────────
  225.    For those of you with a CD-ROM drive,  FFG will create FILESIZE.nnn files
  226.    in the listpath directory (where your FILES.nnn files are stored) accord-
  227.    ing to CONFIG.RA.   Subsequent  file listings will  run much faster since
  228.    file sizes won't need to be determined from the CD-ROM.   Should you ever
  229.    need to rescan  the filesizes  (say if you sorted  FILES.40 in descending
  230.    order) just delete the FILESIZE.nnn file associated with each area that's
  231.    changed and rerun FFG.
  232.  
  233.    SUPPORT
  234.    ─────────────────────────────────────────────────────────────────────────
  235.    Need help? Contact me in Fido's RA_UTIL echo, netmail, on the BBS (see #s
  236.    above), via US Mail or bunji through my apartment window).
  237.  
  238.    CREDITS
  239.    ─────────────────────────────────────────────────────────────────────────
  240.    ■ Special thanks to
  241.        ■ William Herrington - The SaddleBag BBS - 1:374/38
  242.        ■ Wai Wong - Wai's BBS - 1:153/754
  243.        ■ Bob Knowles - Beach Ribbs - 1:271/58
  244.    ─────────────────────────────────────────────────────────────────────────
  245.    Enjoy!
  246.